Skip to content

change: Add warning for ignored job args in pipeline steps #3814

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

change: Add warning for ignored job args in pipeline steps #3814

wants to merge 1 commit into from
+219 −2

Conversation

@qidewenwhen
Copy link
Contributor

@qidewenwhen qidewenwhen commented Apr 26, 2023

Issue #, if available: #3642

Description of changes: As indicated in the issue above, customers may mix use the two different sets of arguments relating to the new and legacy pipeline step interfaces, which causes confusions as the legacy args will be ignored silently. This PR exposes warning messages for this case.

In addition, this PR refines the warning message in override_pipeline_parameter_var as the previous one causes confusion.

Testing done: Unit tests

Merge Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your pull request.

General

  • I have read the CONTRIBUTING doc
  • I certify that the changes I am introducing will be backward compatible, and I have discussed concerns about this, if any, with the Python SDK team
  • I used the commit message format described in CONTRIBUTING
  • I have passed the region in to all S3 and STS clients that I've initialized as part of this change.
  • I have updated any necessary documentation, including READMEs and API docs (if appropriate)

Tests

  • I have added tests that prove my fix is effective or that my feature works (if appropriate)
  • I have added unit and/or integration tests as appropriate to ensure backward compatibility of the changes
  • I have checked that my tests are not configured for a specific region or account (if appropriate)
  • I have used unique_name_from_base to create resource names in integ tests (if appropriate)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@qidewenwhen qidewenwhen requested a review from a team as a code owner April 26, 2023 02:28
@qidewenwhen qidewenwhen requested review from claytonparnell and removed request for a team April 26, 2023 02:28
@qidewenwhen qidewenwhen mentioned this pull request Apr 26, 2023
Closed
@sagemaker-bot
Copy link
Collaborator

sagemaker-bot commented Apr 26, 2023

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-unit-tests
  • Commit ID: 3fede65
  • Result: FAILED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-bot
Copy link
Collaborator

sagemaker-bot commented Apr 26, 2023

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-pr
  • Commit ID: 3fede65
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-bot
Copy link
Collaborator

sagemaker-bot commented Apr 26, 2023

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-local-mode-tests
  • Commit ID: 3fede65
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-bot
Copy link
Collaborator

sagemaker-bot commented Apr 26, 2023

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-notebook-tests
  • Commit ID: 3fede65
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-bot
Copy link
Collaborator

sagemaker-bot commented Apr 26, 2023

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-slow-tests
  • Commit ID: 3fede65
  • Result: FAILED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-bot
Copy link
Collaborator

sagemaker-bot commented Apr 26, 2023

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-pr
  • Commit ID: 1504394
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-bot
Copy link
Collaborator

sagemaker-bot commented Apr 26, 2023

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-local-mode-tests
  • Commit ID: 1504394
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-bot
Copy link
Collaborator

sagemaker-bot commented Apr 26, 2023

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-notebook-tests
  • Commit ID: 1504394
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-bot
Copy link
Collaborator

sagemaker-bot commented Apr 26, 2023

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-unit-tests
  • Commit ID: 1504394
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-bot
Copy link
Collaborator

sagemaker-bot commented Apr 26, 2023

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-slow-tests
  • Commit ID: 1504394
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@codecov-commenter
Copy link

codecov-commenter commented Apr 26, 2023

Codecov Report

Merging #3814 (1504394) into master (8ac6ca8) will decrease coverage by 0.74%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master    #3814      +/-   ##
==========================================
- Coverage   89.89%   89.16%   -0.74%     
==========================================
  Files        1060      247     -813     
  Lines      101168    25048   -76120     
==========================================
- Hits        90942    22333   -68609     
+ Misses      10226     2715    -7511
Impacted Files Coverage Δ
src/sagemaker/workflow/utilities.py 90.96% <ø> (ø)
src/sagemaker/workflow/steps.py 95.41% <100.00%> (ø)

... and 1305 files with indirect coverage changes

@knikure knikure linked an issue Apr 26, 2023 that may be closed by this pull request
PropertyFile for ProcessingStep using FrameworkProcessor and step_args not recognized. #3642
Closed
nmadan
nmadan reviewed Apr 26, 2023
View reviewed changes
src/sagemaker/workflow/steps.py
error_message="The step_args of ProcessingStep must be obtained from processor.run().",
)

if job_arguments or inputs or outputs or code or kms_key:
Copy link
Member

@nmadan nmadan Apr 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we check for each individually? Otherwise the error message might get confusing

nmadan
nmadan reviewed Apr 26, 2023
View reviewed changes
src/sagemaker/workflow/steps.py

JOB_ARG_IGNORE_WARN_MSG_TEMPLATE = (
"The job specific arguments (%s) supplied to the step will be ignored, "
"because `step_args` is presented. These job specific arguments should be supplied "
Copy link
Member

@nmadan nmadan Apr 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: typo in presented. Should be replaced with present

nmadan
nmadan reviewed Apr 26, 2023
View reviewed changes
src/sagemaker/workflow/utilities.py
warning_msg_template = (
"The input argument %s of function (%s) is a pipeline variable (%s), which is not allowed. "
"The default_value of this Parameter object will be used to override it. "
"The input argument %s of function (%s) is a pipeline variable (%s), which will not work. "
Copy link
Member

@nmadan nmadan Apr 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The obvious question here for any user will be: "why will it not work?"

We should get this reviewed by a doc writer to get the least confusing wording

@knikure knikure added the do-not-merge Use when PR needs to be marked as do not merge label Apr 27, 2023
@knikure knikure self-assigned this May 5, 2023
@qidewenwhen qidewenwhen marked this pull request as draft May 16, 2023 00:16
@knikure
Copy link
Contributor

knikure commented Jul 6, 2023 •
edited
Loading

@qidewenwhen Are you still working on this PR? Can you resolve conflicts?

@qidewenwhen qidewenwhen closed this Aug 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@claytonparnell claytonparnell Awaiting requested review from claytonparnell claytonparnell is a code owner automatically assigned from aws/sagemaker-ml-frameworks

2 more reviewers

@nmadan nmadan nmadan left review comments

@knikure knikure knikure approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@knikure knikure

Labels

do-not-merge Use when PR needs to be marked as do not merge

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

PropertyFile for ProcessingStep using FrameworkProcessor and step_args not recognized.

5 participants

@qidewenwhen @sagemaker-bot @codecov-commenter @knikure @nmadan